<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" Content="text-html; charset=Windows-1252">
<title>WinHelp</title>
<style>@import url(coUA.css);</style>
<link disabled rel="stylesheet" href="htmlhelp.css">
</HEAD>

<BODY>
<h1><a name="ocx_winhelp"></a>WinHelp command</h1>

<h2>Purpose</h2>

<p>Displays a WinHelp topic in the WinHelp primary window, a WinHelp secondary window, or in a WinHelp pop-up window. The specific window attributes, such as size and position, background color, and button bar items, are based on the definitions in the <code>[WINDOWS]</code> section of the specified WinHelp project (.hpj) file. </p> 

<p>This command can be used only with a compiled help (.chm) file.</p>

<h2>Syntax</h2>

<p><pre><code>
<br>&lt;PARAM  name="Command" value="WinHelp [,Popup]&gt;
<br>&lt;PARAM  name="Item2"   value="<i>topic ID</i>|<i>map number</i>"&gt;
<br>&lt;PARAM  name="Item1"   value="<i>WinHelp (.hlp) file path</i> [&gt;<i>window name</i>]"&gt;
<br>[&lt;PARAM name="Button"  value="[Text: <i>Button text</i>|Bitmap: <i>Bitmap file path</i>|Icon:<i>Icon file path</i>]"&gt;]
<br>[&lt;PARAM name="Font"    value="<i><i>Facename[, point size[, charset[, color[, PLAIN BOLD ITALIC UNDERLINE]]]]</i></i>"&gt;]
<br>[&lt;PARAM name="Text"    value="Text: <i>Link text</i>"&gt;]
</pre></code></p>

<br>
<table border=1 cellpadding=0 cellspacing=0 width=100%>
<tr valign=top>
<th width=25%>
<b>Property</b>
</th>
<th>
<b>Description</b>
</th>
</tr>

<tr valign=top>
<td>
<a href="ocx_pbutton.htm">Button</a>
</td>
<td>
Specifies the button style. Optional.
</td>
</tr>

<tr valign=top>
<td>
<a href="ocx_pcommand.htm">Command</a>
</td>
<td>
Calls the <b>WinHelp</b> command and specifies a <a href="winhelp_window_types.htm">WinHelp window type</a>.
<ul>
<li>To display a pop-up WinHelp window, type <b>Popup</b>.</li>
<br>
<li>To display a secondary WinHelp window, do not specify a window type and specify a window name in the <b>Item1</b> parameter.</li> 
<br>
<li>To display the WinHelp main window, do not specify a window type or a window name (in the <b>Item1</b> parameter).</li>
</ul> 
</td>
</tr>

<tr valign=top>
<td>
<a href="ocx_pfont.htm">Font</a>
</td>

<td>
Specifies the font attributes. Optional.
</td>
</tr>

<tr valign=top>
<td>
<a href="ocx_pitem.htm">Item1</a>
</td>
<td>
Specifies the file path of the WinHelp (.hlp) file in which the WinHelp topic is stored, and the window name of the target window.
<p>
The window name must be preceded by the &quot;&gt;&quot; character.
<p>
Do not specify a window name if you typed <b>Popup</b> in the <b>Command</b> parameter or if you want the topic to appear in the WinHelp main window.
</td>
</tr>

<tr valign=top>
<td>
<a href="ocx_pitem.htm">Item2</a>
<td>
Specifies the topic ID or map number of the WinHelp topic to display.
</td> 
</tr>

<tr valign=top>
<td>
<a href="ocx_ptext.htm">Text</a>
</td>

<td>
Specifies the link text. Optional.
</td>
</tr>
</table>


<h2>Example</h2>
<p><pre><code>
&lt;OBJECT
<br>  id=winhelp
<br>  type="application/x-oleobject"
<br>  classid="clsid:adb880a6-d8ff-11cf-9377-00aa003b7a11"
<br>  codebase="hhctrl.ocx#Version=4,72,8252,0"
<br>  width=100
<br>  height=100
&gt;
<br>  &lt;PARAM name="Command" value="WinHelp"&gt;
<br>  &lt;PARAM name="Button" value="Text: Candomble Overview"&gt;
<br>  &lt;PARAM name="Item1" value="c:\winhelp\candomble_wh.hlp>MyWindow"&gt;
<br>  &lt;PARAM name="Item2" value="myth_candomble_overview"&gt;
<br>&lt;/OBJECT&gt;
</pre></code></p>

<h2>Comments</h2>
<ul>
<li>The <b>Button</b> parameter is omitted when this command is invoked by a script.</li>
</ul>

<br>
<table border="0" cellpadding="0" cellspacing="4">
<tr>
<td valign="top"><a href="ocx_commands.htm"><img src="proced.gif" alt="link to overview topic" border="0"></a>
</td>
<td><a href="ocx_commands.htm">About commands</A>
</td>
</tr>
<tr>
<td>&nbsp;</td>
</tr>
</table>
</BODY>
</HTML>
